home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / programer2 / euclidlib / !Example / !Help < prev    next >
Text File  |  1992-04-21  |  5KB  |  118 lines

  1. !Example by Paul Field
  2. See !ReadMe for distribution/modification restrictions
  3.  
  4. This program 'example' is provided as an example of how to use the euclid
  5. library. It 'plots' and displays various functions in various ways - 
  6. most of which are under user control from menus.
  7.  
  8. There are two environmental variables that are set in !Run.
  9. 'Example$Seperatecaches' determines whether each picture has a seperate drawing
  10. cache or not. If it is 'no' then all of the graphs will share a single drawing
  11. cache and so if several graphs want to draw at the same time they will do so
  12. sequentially. If is not a good idea to set this to 'no' if you are raytracing
  13. a picture.
  14. The cache size is determined by the environmental variable 'Example$Cachesize'.
  15. You should probably increase this if you want to ray trace.
  16.  
  17. Known bugs:
  18.    The palette is not defined properly when drawing sprites, so in some cases
  19.    sprites will be drawn with strange colours.
  20.    Drawing 256-colour sprites should always work.
  21.    Drawing n-colour sprites in n-colour modes should always work.
  22.    Otherwise expect problems.
  23.  
  24.  
  25. The icon bar menu
  26. =================
  27.  
  28. Info    gives information about the program.
  29. Graph1  }
  30. Graph2  } opens a window onto a particular graph (open graphs become ticked)
  31. Graph3  }
  32. Quit    leaves the program
  33.  
  34.  
  35. The graph menu  (Click 'menu' over a graph window)
  36. ==============
  37.  
  38. Save     Leads to the 'Save menu', from here you can save either a
  39.          Euclid file or a sprite file of the graph. You need to have enabled
  40.          'sprite mode' and the sprite must be drawn before you can save the
  41.          sprite (the sprite option will be faded until this is so).
  42. Style    Leads to the 'Style' menu. From here you can select the style of the
  43.          picture. See the section at the end on 'ray tracing' if you wish to
  44.          use that option.
  45. Sprite   Clicking here toggles 'sprite mode'. In sprite mode the euclid picture
  46.          is drawn into a sprite (if there is enough memory). This makes
  47.          redrawing the picture very fast. Try dragging another window across
  48.          the graph when it is in sprite mode and when it isn't.
  49.          This option has a sub-menu that determines various features of the
  50.          sprite and the way it is drawn (see 'Sprite Menu' below).
  51.          If there isn't enough memory when you enable sprite mode then
  52.          'Sprite' will still be ticked but the window will be redrawn
  53.          in the usual way. However, if memory becomes available later
  54.          the window will grab it and start using a sprite.
  55. Rotate   Causes the graph to start/stop rotating around the vertical axis
  56.  
  57.  
  58. The sprite menu
  59. ===============
  60.  
  61. Multitask  Leads to a 'multitask' menu.
  62.            Euclid pictures take time to draw and usually hold the computer
  63.            up while they are being generated. However, there are three
  64.            'multitask' modes available that split the drawing process into
  65.            sections when 'sprite mode' is enabled.
  66.            'Slow'  draws very small sections at a time.
  67.            'Fast'  draws fairly large sections at a time.
  68.            'VFast' draws very large sections at a time.
  69.            The 'None' option disables multitasking.
  70.            You can only see the effect of multitasking when the sprite is
  71.            being drawn. This can be forced to happen by changing the
  72.            mode of the sprite (see the next option) or by closing and then
  73.            reopening the graph.
  74. Mode       Leads to the 'mode' menu.
  75.            This simply defines the mode of the sprite. Type in the mode
  76.            that you want into the writable icon at the bottom of the menu.
  77.            There are two special options :
  78.            'Current' simply selects the current mode.
  79.            'Dynamic' makes the picture keep track with the current mode.
  80.                      This means that if you start in mode 12 and select
  81.                     'dynamic' (with sprite mode enabled) you will get a mode
  82.                      12 sprite. If you then change to mode 15 the sprite will
  83.                      be redrawn as a mode 15 sprite.
  84.  
  85. Ray tracing
  86. ===========
  87.  
  88. The ray tracing style is only active under the following circumstances :
  89.   i) Sprite mode is enabled (and the window is actually using a sprite).
  90.  ii) The sprite's mode is not 'dynamic'
  91. iii) Multitasking is enabled
  92.  iv) The graph is not rotating
  93.  
  94. These restrictions are only there to protect you and the multitasking sprite.
  95. You should also choose a 256-colour to ray trace in, pictures in less colours
  96. come out rather poorly.
  97.  
  98. Notice that once the raytracing style is selected the mode 'Dynamic'
  99. and the multitasking 'None' options will be shaded as well as 'Rotate'.
  100.  
  101. Usually when you close the window the sprite is removed and redrawn when the
  102. window is opened. However, raytraced sprites remain attached to the window
  103. and drawing continues even though the window is closed.
  104.  
  105.  
  106.  
  107.  
  108. If you have any comments or queries contact :
  109.  
  110. Paul Field
  111. 3, Little Heath
  112. Chadwell Heath
  113. Romford
  114. Essex
  115. RM6 4XX
  116.  
  117. email: paulf@dcs.qmw.ac.uk   (Until the end of 1994)
  118.